HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
​0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ZM-Core Communication Profile

Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-communication Version: 0.1.0
Active as of 2026-08-12 Computable Name: ZMCoreCommunication

The immutable delivery or receipt record produced for a communication request, including channel and delivery outcome.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:dataClassification S 1..1 CodeableConcept Communication Data Classification
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification
Binding: Zambia Communication Data Classification Value Set (required)
.... extension:approvedTemplate S 1..1 Identifier Approved Communication Template
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template
.... extension:messageLanguage S 1..1 code Communication Message Language
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language
Binding: AllLanguages (required)
... identifier SΣ 1..* Identifier Unique identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... basedOn SΣ 1..* Reference(ZM-Core Communication Request Profile) Request fulfilled by this communication
... inResponseTo S 0..* Reference(Communication) Reply to
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
... statusReason SΣ 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
... category S 1..* CodeableConcept Message category
Binding: Zambia Communication Lane Value Set (required)
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium S 1..1 CodeableConcept A channel of communication
Binding: Zambia Communication Channel Value Set (required)
... subject SΣ 0..1 Reference(Patient | Group) Focus of message
... topic S 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
... about S 0..* Reference(Resource) Resources that pertain to this communication
... sent S 1..1 dateTime When sent
... received S 0..1 dateTime When received
... recipient S 1..* Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) Who shares the information
... reason SΣ 0..* CodeableReference(Resource) Indication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
... payload S 1..* BackboneElement Message payload
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] S 1..1 Message part content
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... contentCodeableConcept CodeableConcept
... note S 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.statusReason Base example Communication Not Done Reason 📍5.0.0 FHIR Std.
Communication.category Base required Zambia Communication Lane Value Set 📦0.1.0 This IG
Communication.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Communication.medium Base required Zambia Communication Channel Value Set 📦0.1.0 This IG
Communication.topic Base example Communication Topic 📍5.0.0 FHIR Std.
Communication.reason Base example SNOMED CT Clinical Findings 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Communication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:dataClassification S 1..1 CodeableConcept Communication Data Classification
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification
Binding: Zambia Communication Data Classification Value Set (required)
.... extension:approvedTemplate S 1..1 Identifier Approved Communication Template
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template
.... extension:messageLanguage S 1..1 code Communication Message Language
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language
Binding: AllLanguages (required)
... identifier S 1..* Identifier Unique identifier
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... basedOn S 1..* Reference(ZM-Core Communication Request Profile) Request fulfilled by this communication
... status S 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... statusReason S 0..1 CodeableConcept Reason for current status
... category S 1..* CodeableConcept Message category
Binding: Zambia Communication Lane Value Set (required)
... priority S 0..1 code routine | urgent | asap | stat
... medium S 1..1 CodeableConcept A channel of communication
Binding: Zambia Communication Channel Value Set (required)
... subject S 0..1 Reference(Patient | Group) Focus of message
... topic S 0..1 CodeableConcept Description of the purpose/content
... about S 0..* Reference(Resource) Resources that pertain to this communication
... sent S 1..1 dateTime When sent
... received S 0..1 dateTime When received
... recipient S 1..* Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) Who shares the information
... reason S 0..* CodeableReference(Resource) Indication for message
... payload S 1..* BackboneElement Message payload
.... content[x] S 1..1 Attachment, Reference(Resource), CodeableConcept Message part content
... note S 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Communication.category Base required Zambia Communication Lane Value Set 📦0.1.0 This IG
Communication.medium Base required Zambia Communication Channel Value Set 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:dataClassification S 1..1 CodeableConcept Communication Data Classification
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification
Binding: Zambia Communication Data Classification Value Set (required)
.... extension:approvedTemplate S 1..1 Identifier Approved Communication Template
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template
.... extension:messageLanguage S 1..1 code Communication Message Language
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language
Binding: AllLanguages (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Unique identifier
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 1..* Reference(ZM-Core Communication Request Profile) Request fulfilled by this communication
... partOf Σ 0..* Reference(Resource) Part of referenced event (e.g. Communication, Procedure)
... inResponseTo S 0..* Reference(Communication) Reply to
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
... statusReason SΣ 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
... category S 1..* CodeableConcept Message category
Binding: Zambia Communication Lane Value Set (required)
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium S 1..1 CodeableConcept A channel of communication
Binding: Zambia Communication Channel Value Set (required)
... subject SΣ 0..1 Reference(Patient | Group) Focus of message
... topic S 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
... about S 0..* Reference(Resource) Resources that pertain to this communication
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this Communication was created
... sent S 1..1 dateTime When sent
... received S 0..1 dateTime When received
... recipient S 1..* Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) Who shares the information
... reason SΣ 0..* CodeableReference(Resource) Indication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
... payload S 1..* BackboneElement Message payload
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] S 1..1 Message part content
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... contentCodeableConcept CodeableConcept
... note S 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.language Base required All Languages 📍5.0.0 FHIR Std.
Communication.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Communication.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.statusReason Base example Communication Not Done Reason 📍5.0.0 FHIR Std.
Communication.category Base required Zambia Communication Lane Value Set 📦0.1.0 This IG
Communication.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Communication.medium Base required Zambia Communication Channel Value Set 📦0.1.0 This IG
Communication.topic Base example Communication Topic 📍5.0.0 FHIR Std.
Communication.reason Base example SNOMED CT Clinical Findings 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Communication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:dataClassification S 1..1 CodeableConcept Communication Data Classification
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification
Binding: Zambia Communication Data Classification Value Set (required)
.... extension:approvedTemplate S 1..1 Identifier Approved Communication Template
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template
.... extension:messageLanguage S 1..1 code Communication Message Language
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language
Binding: AllLanguages (required)
... identifier SΣ 1..* Identifier Unique identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... basedOn SΣ 1..* Reference(ZM-Core Communication Request Profile) Request fulfilled by this communication
... inResponseTo S 0..* Reference(Communication) Reply to
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
... statusReason SΣ 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
... category S 1..* CodeableConcept Message category
Binding: Zambia Communication Lane Value Set (required)
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium S 1..1 CodeableConcept A channel of communication
Binding: Zambia Communication Channel Value Set (required)
... subject SΣ 0..1 Reference(Patient | Group) Focus of message
... topic S 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
... about S 0..* Reference(Resource) Resources that pertain to this communication
... sent S 1..1 dateTime When sent
... received S 0..1 dateTime When received
... recipient S 1..* Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) Who shares the information
... reason SΣ 0..* CodeableReference(Resource) Indication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
... payload S 1..* BackboneElement Message payload
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] S 1..1 Message part content
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... contentCodeableConcept CodeableConcept
... note S 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.statusReason Base example Communication Not Done Reason 📍5.0.0 FHIR Std.
Communication.category Base required Zambia Communication Lane Value Set 📦0.1.0 This IG
Communication.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Communication.medium Base required Zambia Communication Channel Value Set 📦0.1.0 This IG
Communication.topic Base example Communication Topic 📍5.0.0 FHIR Std.
Communication.reason Base example SNOMED CT Clinical Findings 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Communication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:dataClassification S 1..1 CodeableConcept Communication Data Classification
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification
Binding: Zambia Communication Data Classification Value Set (required)
.... extension:approvedTemplate S 1..1 Identifier Approved Communication Template
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template
.... extension:messageLanguage S 1..1 code Communication Message Language
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language
Binding: AllLanguages (required)
... identifier S 1..* Identifier Unique identifier
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... basedOn S 1..* Reference(ZM-Core Communication Request Profile) Request fulfilled by this communication
... status S 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
... statusReason S 0..1 CodeableConcept Reason for current status
... category S 1..* CodeableConcept Message category
Binding: Zambia Communication Lane Value Set (required)
... priority S 0..1 code routine | urgent | asap | stat
... medium S 1..1 CodeableConcept A channel of communication
Binding: Zambia Communication Channel Value Set (required)
... subject S 0..1 Reference(Patient | Group) Focus of message
... topic S 0..1 CodeableConcept Description of the purpose/content
... about S 0..* Reference(Resource) Resources that pertain to this communication
... sent S 1..1 dateTime When sent
... received S 0..1 dateTime When received
... recipient S 1..* Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) Who shares the information
... reason S 0..* CodeableReference(Resource) Indication for message
... payload S 1..* BackboneElement Message payload
.... content[x] S 1..1 Attachment, Reference(Resource), CodeableConcept Message part content
... note S 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Communication.category Base required Zambia Communication Lane Value Set 📦0.1.0 This IG
Communication.medium Base required Zambia Communication Channel Value Set 📦0.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Communication 0..* Communication A clinical or business level record of information being transmitted or shared
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:dataClassification S 1..1 CodeableConcept Communication Data Classification
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-data-classification
Binding: Zambia Communication Data Classification Value Set (required)
.... extension:approvedTemplate S 1..1 Identifier Approved Communication Template
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-template
.... extension:messageLanguage S 1..1 code Communication Message Language
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-communication-message-language
Binding: AllLanguages (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Unique identifier
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 1..* Reference(ZM-Core Communication Request Profile) Request fulfilled by this communication
... partOf Σ 0..* Reference(Resource) Part of referenced event (e.g. Communication, Procedure)
... inResponseTo S 0..* Reference(Communication) Reply to
... status ?!SΣ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): The status of the communication.
... statusReason SΣ 0..1 CodeableConcept Reason for current status
Binding: CommunicationNotDoneReason (example): Codes for the reason why a communication did not happen.
... category S 1..* CodeableConcept Message category
Binding: Zambia Communication Lane Value Set (required)
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication.
... medium S 1..1 CodeableConcept A channel of communication
Binding: Zambia Communication Channel Value Set (required)
... subject SΣ 0..1 Reference(Patient | Group) Focus of message
... topic S 0..1 CodeableConcept Description of the purpose/content
Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication.
... about S 0..* Reference(Resource) Resources that pertain to this communication
... encounter Σ 0..1 Reference(Encounter) The Encounter during which this Communication was created
... sent S 1..1 dateTime When sent
... received S 0..1 dateTime When received
... recipient S 1..* Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Endpoint) Who the information is shared with
... sender S 1..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService | Endpoint | CareTeam) Who shares the information
... reason SΣ 0..* CodeableReference(Resource) Indication for message
Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication.
... payload S 1..* BackboneElement Message payload
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... content[x] S 1..1 Message part content
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... contentCodeableConcept CodeableConcept
... note S 0..* Annotation Comments made about the communication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Communication.language Base required All Languages 📍5.0.0 FHIR Std.
Communication.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Communication.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Communication.status Base required EventStatus 📍5.0.0 FHIR Std.
Communication.statusReason Base example Communication Not Done Reason 📍5.0.0 FHIR Std.
Communication.category Base required Zambia Communication Lane Value Set 📦0.1.0 This IG
Communication.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Communication.medium Base required Zambia Communication Channel Value Set 📦0.1.0 This IG
Communication.topic Base example Communication Topic 📍5.0.0 FHIR Std.
Communication.reason Base example SNOMED CT Clinical Findings 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Communication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Communication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Communication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Communication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Communication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron